Exemplo: Como criar um manual do usuário
A função de um manual do usuário é fornecer instruções sobre como fazer algo ou utilizar algum produto
Relacionamentos
Descrição Principal

Para criar uma documentação de usuário adequada, a seguir são descritos alguns passos:

  • Definir o usuário: Desenvolva o perfil do usuário alvo, leve em consideração onde e como o usuário utilizará o manual e na experiência que o usário tem com produto, caso seja um produto novo é necessário explicar as diferenças e incluir instruções sobre como começar o uso.
  • Descrever as necessidades do usuário de modo que ele possa compreender: O texto deve conter explicações simples, claras e ser organizado de modo a imitar o pensamento dos usuários.
  • Explicar o problema que o usuário está tentando solucionar e apresentar a solução: Identifique problemas específicos que a pessoa enfrentará, explique-os no manual e conclua com as instruções para solucioná-los.

Principais componentes de um manual:

  • Capa e páginas de título: Você precisará de uma capa para qualquer manual que não seja um simples cartão de referência e uma página de título para qualquer manual que seja mais do que uma folha de papel dobrado.
  • Referências aos documentos relacionados no prefácio: Caso a documentação não seja apenas o manual, referencie os demais documentos. A seção "Como utilizar esse guia", se houver uma, fica no prefácio.
  • Índice caso o manual possua mais de 10 páginas.
  • Instruções/procedimentos e materiais de referência no corpo do manual: Na maioria dos casos, esses itens devem possui seções próprias, mas é possível instruir o leitor a consultar um conteúdo específico de uma seção na outra. Desse modo, o usuário é capaz de encontrar a informação procurada mais rapidamente.
  • Imagens para apoio, caso necessário: Imagens podem ilustrar certas ideias melhor que os textos, principalmente ao descrever procedimentos complexos onde o usuário precisa de informações visuais para se certificar de que está realizando os passos corretamente. As imagens podem ser produzidas com softwares de desenho, câmeras digitais e softwares de edição de imagem.


Algumas dicas para o desenvolvimento do manual:


  • Escolha fontes legíveis: A meta de um manual do usuário é a facilidade de leitura. Escolher um número pequeno de fontes que combinem é a melhor opção para isso.
  • Avalie bem o layout da página: É necessário escolher a diagramação de tudo que vai na página, algumas dicas é inserir textos explicativos em caixas coloridas ou sombreadas para separá-los do resto do texto e escolher uma cor ou nível de sombreamento que não se sobreponha ao texto.
  • Crie um modelo para o manual: Diversos softwares de processamento de texto e editoração possuem uma função para criar um modelo, crie todos os estilos que utilizará com antecedência para que não precise parar e criá-los durante o processo de escrita.